Close Period Commands

CygNet Measurement > FMS Commands > User: Close Period

User: Close Period

Note: This functionality is only available in systems licensed for FULL mode.

Close Period is a Node-level command that triggers the service to close (or test close) data records for each eligible Gas Meter Node (device or station meters), Liquid Device Node (with support for periodic history), or Station Group Node the command resolves to, from the "closed through" date of the previously closed record through a specified date, in Contract time (C). Close periods can be applied to dates two days in the past (current date minus two contract days) or prior, and records are closed through midnight of the specified contract day.

Note: In the close period process, the "closed through" date of the previously closed record determines the starting date of the time range to close. If a Node record has never been closed previously, the start of the closed period is the timestamp when the Node first started receiving data.

Records must satisfy the conditions configured in the Administrative System Options before they can be closed successfully. The "test close" option reports any outstanding issues or errors to be resolved in order to meet conditions and close the period. See the Close Period section in Configuring Systems Options for more information about close period requirements.

Group (Station Group - see Note*) Nodes, Liquid Device Nodes (with support for periodic history), or Gas Device (Gas Meter and Station Meter) Nodes are eligible if the following apply.

*Note: Do not run this command against a General Group Node. To close period for member Nodes belonging to a General Group Node, run the command against the applicable member Node(s).

The associated device records in the DDS are enabled
There is data in the specified time range
The user executing the command has the appropriate security access
The date specified is after the current "closed through" date
For Liquid Device Nodes, the Node supports periodic history data

The record periods to be closed (or tested) are determined by specifying a "close through" date via the command parameters. When the command is run, the system checks the conditions governing whether the period can be closed and reports results for any outstanding issues that need to be resolved. Once all conditions are satisfied, the records for that period can be closed.

You must have proper security authorization to execute this command. See FMS Security (and CLOSE security event) for information about configuring security access for FMS commands.

See Close Period in the CygNet Measurement Concepts section, and Testing and Closing Periods for more information about closing or test closing data.

See Using the Close Period Control for information about running this command via the Close Period control in FMS Explorer.

See Running Node Commands and Configuring Close Period Commands for more information about using this command via FMS Explorer.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See Viewing Command Logs for information about accessing historical logs for this command.

Command Definition Properties

The following command definition properties apply to Close Period commands, when scheduling, creating, or editing commands via CygNet Explorer.

Property	Description
FMS service	Select a Site.Service for the command from the available FMS service list in the drop-down menu.
Command	Select the desired Command name from the drop-down menu. See FMS Commands for more information about available command types.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low - displays errors Medium - displays errors and warnings High - displays errors, warnings, and status Default value is Low level logging when scheduling a command via the MSS service in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS service in CygNet Explorer.

Command Parameters

The following command parameters apply to Close Period commands, when running a <Quick Command> via CygNet Explorer. You cannot schedule Close Period commands.

Description	Required	Value
Close through date (C)	Yes	Click in the Value field to access the date field and do one of the following. Click ... to access the Select Date dialog box to define the date. Type in the date through which to close data, in Contract time (C). See Selecting Date and Time for more information. This parameter is required.
Test close only	Yes	Click in the Value field to access the drop-down menu and select one of the following options. Yes No If set to Yes, the command action will only test the selected Node records to determine if all close period conditions are met and report status including any errors. If set to No, the command action will close the period, if all close period conditions are met. See Testing and Closing Periods for more information. This parameter is required.

Description

Required

Value

Close through date (C)

Yes

Click in the Value field to access the date field and do one of the following.

Click ... to access the Select Date dialog box to define the date.
Type in the date through which to close data, in Contract time (C).

See Selecting Date and Time for more information.

This parameter is required.

Test close only

Yes

Click in the Value field to access the drop-down menu and select one of the following options.

Yes
No

If set to Yes, the command action will only test the selected Node records to determine if all close period conditions are met and report status including any errors.

If set to No, the command action will close the period, if all close period conditions are met.

See Testing and Closing Periods for more information.

This parameter is required.